/**
 * Software License, Version 1.0
 * 
 * Copyright 2008 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgment:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgment may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or Granules, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called Granules, 
 * nor may Indiana University or Community Grids Lab or Granules appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 * LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 * WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 * NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 * INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 * INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 * "VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 * LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 * ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 * GENERATED USING SOFTWARE.
 */
package cgl.granules.operation;

import cgl.granules.results.Results;

/**
 * This is an interface which encapsulates functionality that is common to both
 * the <code>Map</code> and <code>Reduce</code> roles that are associated with
 * the applications.
 * 
 * @author Shrideep Pallickara
 * 
 */
public interface MapReduce extends Operation {

	/**
	 * Create the <code>Results</code> type to be used for reporting results
	 * produced as a result of the processing.
	 * 
	 * @param completeResult
	 * @param processingComplete
	 * @return The created <code>Results</code>.
	 */
	public Results createResults(boolean completeResult,
			boolean processingComplete);

	/**
	 * Writes the specified results to the default output stream.
	 * 
	 * @param results
	 *            The results to be written.
	 * @throws MapReduceException
	 *             If there are problems in marshalling or writing these
	 *             results.
	 * @throws NullPointerException
	 *             If the specified results are null.
	 */
	public void writeResults(Results results) throws MapReduceException;

	/**
	 * Writes the specified results to a specific output stream.
	 * 
	 * @param streamSynopsis The synopsis for the stream
	 * @param results The results that needs to be written
	 * @throws MapReduceException
	 *             If there are problems in marshalling or writing these
	 *             results.
	 * @throws NullPointerException
	 *             if the specified stream or the results are null.
	 */
	public void writeResults(String streamSynopsis, Results results)
			throws MapReduceException;

	/**
	 * Writes the specified results to a specific output stream.
	 * 
	 * @param synopsisType The synopsis type for the stream in question
	 * @param streamSynopsis The synopsis for the stream
	 * 
	 * @param results The results that needs to be written
	 * @throws MapReduceException
	 *             If there are problems in marshalling or writing these
	 *             results.
	 * @throws NullPointerException
	 *             if the specified stream or the results are null.
	 */
	public void writeResults(int synopsisType, String streamSynopsis, 
			Results results) throws MapReduceException;
}
